Skip to main content
POST
/
v1
/
shipping
/
shipments
/
{id}
/
pick
Pick Shipment
curl --request POST \
  --url https://{base_url_domain}/api/global/v1/shipping/shipments/{id}/pick \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pick_locations": [
    {
      "location_label": "<string>",
      "quantity": 123
    }
  ],
  "reservation_refs": [
    {
      "id": 123,
      "quantity": 123
    }
  ]
}
'
{
  "errors": [
    {
      "type": "parameters",
      "message": "The supplied parameters are invalid.",
      "details": [
        {
          "key": "hold_until_date",
          "message": "The date must be in the future."
        }
      ]
    }
  ]
}

Authorizations

ā€‹
Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

ā€‹
id
integer
required

The id of the referenced Shipment.

Required range: x >= 1

Body

application/json
ā€‹
pick_locations
PickupLocation Ā· object[]

Optionally specify the exact locations and amounts which should be picked. If not specified then all locations for this shipment will be picked. Cannot be used together with reservation_refs.

ā€‹
reservation_refs
object[]

Optionally specify the exact reservations to pick by their IDs. If not specified then all reservations for this shipment will be picked. Cannot be used together with pick_locations.

Response

OK - The operation completed successfully and there is no response body.